(dired-log-summary): Add doc string.

diff --git a/lisp/dired.el b/lisp/dired.el
index 59fb21a004f5fc2aa029900a540b1ee9a3e5faa9..2974b386d0bf2fc5c4c99bfb5173431f773b5e98 100644 (file)
--- a/lisp/dired.el
+++ b/lisp/dired.el
@@ -3043,6 +3043,10 @@ Thus, use \\[backward-page] to find the beginning of a group of errors."
               (insert "\f\n")))))))
 
 (defun dired-log-summary (string failures)
+  "State a summary of a command's failures, in echo area and log buffer.
+STRING is an overall summary of the failures.
+FAILURES is a list of file names that we failed to operate on,
+or nil if file names are not applicable."
   (if (= (length failures) 1)
       (message "%s"
               (with-current-buffer dired-log-buffer